Update Retail User
👤➡️🌐 Update Retail User Request (Client → WCF REST Service)
This message is sent by the Client to the WCF REST Service for modifying any particular details of a Web Retail User in ODIN and WebAdmin.
The Service will validate the request based on the parameters sent and upon successful modification of the user, it will send the response back in XML format.
In case of failure, it will send a failure response.
📘 Tags and Fields
| Tag | Field Name | Req’d | Data Type (Max) | Comment |
|---|---|---|---|---|
| 63 | Message Version | Y | String (10) | Fixed Value – FT1.0 |
| 64 | Message Type | Y | Integer | Fixed Value – 320 |
| 67 | Reserved PG Dealer Id | Y | String (10) | Reserved PG Dealer Id |
| 4 | Session Id | Y | String (100) | Must match session id received on logon response |
| 201 | User Id | Y | String (10) | Web Retail User Id |
| 202 | Group Id | Y | String (10) | Group Id of the user |
| 203 | Manager Id | Y | String (50) | ODIN Manager identifier (IP or DNS). Must match ODIN Manager Settings in WebAdmin. Optional for non-ODIN users |
| 206 | Name | O | String (40) | First & Last Name separated by space |
| 209 | Address Line 1 | O | String (40) | Address Line 1 |
| 210 | Address Line 2 | O | String (40) | Address Line 2 |
| 211 | City | O | String (40) | City |
| 212 | Pin code | O | String (6) | Pin code |
| 213 | Telephone No | O | String (20) | Telephone No |
| 214 | Mobile No | O | String (14) | Mobile No (updated in Tel No field in ODIN Admin) |
| 215 | Fax No | O | String (20) | Fax No |
| 216 | Email Id | O | String (39) | Email Id |
| 217 | Pan Card | O | String (10) | Pan Card |
| 218 | User Status | O | Char (1) | A – Active, S – Suspended, I – Inactive |
| 219 | Surveillance Auto or Manual | O | Short | 0 – Auto, 1 – Manual |
| 220 | Trading Allowed | O | String (100) | Comma-separated Segment IDs for trading allowed |
| 221 | Market Data Allowed | O | String (100) | Comma-separated Segment IDs for market data allowed |
| 222 | Login Allowed | O | String (100) | Comma-separated Segment IDs for login allowed |
| 223 | Login Type | O | String | Comma-separated Product IDs:DIET=1, ODIN AERO=13, API_WEB=16, API_MOBILE=17, BREEZE=20, ODIN_WAVE_MOB=23 |
| 224 | Bank Details Data | O | String (800) | Multiple bank account details separated by $:Action,BankId,BranchName,BranchCity,AccountNo,CustomerId,AccountType,IsDefaultBank,PGProduct Refer the Bank Details Data table below for detailed filed description. |
| 225 | DP Details | O | String (800) | Multiple Demat account details separated by $. Fields:Action,DP Id,Client Beneficiary Id,Holding Type,Default DP,Guardian First Name,Guardian Last Name,Guardian DOB,Guardian PAN,Second Holder First Name,Second Holder Last Name,Second Holder DOB,Second Holder PAN,Third Holder First Name,Third Holder Last Name,Third Holder DOB,Third Holder PAN,Remarks |
| 227 | Unique Reference Number | O | String (20) | Unique reference number generated by Third Party Application |
| 228 | General Settings Template Name | O | String (50) | GST template name if modifying user’s default GST template |
| 229 | First Holder DOB | O | String (10) | Format: DD-MM-YYYY. Mandatory if updating DP details (Tag-225) or MF UCC (Tag-232) |
| 230 | Odin User Type | M | Short (1) | 0 – Non ODIN User, 1 – ODIN User. Mandatory for identifying current user type |
| 231 | Product Allowed | O | String (50) | Comma-separated Product IDs:2-Mutual Fund, 3-IPO, 4-PMS, 14-BOND, 32-3 in 1 Account |
| 232 | MF UCC Details | O | String (1000) | Exchange-wise UCC mapping, comma-separated:BSEUCC,NSEUCC1,NSEUCC2,NSEUCC3,ModeAllowed,BSETransactionMode,BSE UCC Mode,Holding Mode,MF 2ndApp First Name,...MF Other RTA Payment ModeMandatory if MF product allowed |
| 233 | Gender | O | String (2) | M – Male, F – Female, NA – Firm Account |
| 234 | Client Type | O | String (10) | Mandatory if Product allowed for IPO, BONDS, PMS |
| 235 | Tax Status | O | String (10) | Mandatory if Product allowed for MF, BONDS, PMS |
| 236 | Occupation | O | String (10) | Mandatory if Product allowed for MF, BONDS, PMS |
| 237 | Form60 | O | Short (1) | Y – Yes, N – No |
| 238 | Incorporation Date Flag | O | Short (1) | 1 – Indicates incorporation date update required (Tag-229) |
| 239 | Father/Husband Name | O | String (50) | Father/Husband Name |
| 277 | Inactive Segments | O | String (100) | Comma-separated Segment IDs to inactivate (Not applicable for Non-ODIN user) |
| 278 | Global Flag | O | Short | 0 – Not considered, 1 – Considered (Default: 0) |
| 279 | Number of Orders Per Second | O | Long | Default: -1. Max allowed: 999 |
| 280 | Max Broadcast Scrip Allowed | O | Long | Default: -1. Max allowed: 99999999 |
| 281 | Branch Name | O | String (15) | Branch Name |
| 282 | POA | O | Short | 0 – POA, 2 – Non-POA |
| 247 | Max GTD Allowed | O | Long | Blank or 0 → GTD unchecked. Max allowed: 9999 |
| 248 | Product Type | O | Short | 1 – Margin/IntraDay, 2 – Delivery/CarryForward, 4 – MarginPlus, 8 – MTF, 64 – PTST |
| 999 | Check Sum Value | Y | Integer | Checksum generated based on entire string. Always appended at end |
Examples
✅ String to be passed for generating checksum:
63=FT1.0|64=320|67=RESERVEDPG|4=RESERVEDPG_2312018152511|201=HARDIK2402|202=HO|203=172.25.1.1|204=|205=|206=Hardik Kothiya|208=4|209=Address Line 1|210=Address Line 2|211=Mumbai|212=400011|213=|214=9876543210|215=|216=aaa@bbb.com|217=AAAAA1234A|218=A|219=1|220=1,2,3,4,5|221=1,2,3,4,5|222=1,2,3,4,5|223=1,2,3,7,14,16,17,18,19,20|224=1,AXIS,Kandivali,Mumbai,02145214521423,1111222,CA,0,NSE EQUITIES$2,HDFC,Andheri,Mumbai,04874562102145,99998888,CA,0,NSE EQUITIES|225=1,12345678,1234567898762402,1,Y,,,,,FTIL,Techno,31-08-1992,AAAAA1222A,Moons,Technology,31-08-1992,AAAAA1333A,Remark1|227=|228=TEMP5|229=31-08-1992|230=1|231=2,3,4,14|232=BSEUCC,NSEUCC1,NSEUCC2,,7,2,,JO,Hardik,Kothiya,QWERT1212A,1,T1,T1,HHHHH1234H,1,G1,G2,HHHHH1111A,31-08-1991,1,MUMBAI,N1,N2,31-08-1993,Self,Surat,AM,,AM|233=M|234=IND|235=1|236=1|237=Y|238=|239=MD|277=1,2,3|278=1|279=3|280=15|281=MUMBAI|282=0|247=10|248=1
✅ String to be passed for modifying retail user details along with checksum:
UpdateRetailUser("63=FT1.0|64=320|67=RESERVEDPG|4=RESERVEDPG_2312018152511|201=HARDIK2402|202=HO|203=172.25.1.1|204=|205=|206=Hardik Kothiya|208=4|209=Address Line 1|210=Address Line 2|211=Mumbai|212=400011|213=|214=9876543210|215=|216=aaa@bbb.com|217=AAAAA1234A|218=A|219=1|220=1,2,3,4,5|221=1,2,3,4,5|222=1,2,3,4,5|223=1,2,3,7,14,16,17,18,19,20|224=1,AXIS,Kandivali,Mumbai,02145214521423,1111222,CA,0,NSE EQUITIES$2,HDFC,Andheri,Mumbai,04874562102145,99998888,CA,0,NSE EQUITIES|225=1,12345678,1234567898762402,1,Y,,,,,FTIL,Techno,31-08-1992,AAAAA1222A,Moons,Technology,31-08-1992,AAAAA1333A,Remark1|227=|228=TEMP5|229=31-08-1992|230=1|231=2,3,4,14|232=BSEUCC,NSEUCC1,NSEUCC2,,7,2,,JO,Hardik,Kothiya,QWERT1212A,1,T1,T1,HHHHH1234H,1,G1,G2,HHHHH1111A,31-08-1991,1,MUMBAI,N1,N2,31-08-1993,Self,Surat,AM,,AM|233=M|234=IND|235=1|236=1|237=Y|238=|239=MD|277=1,2,3|278=1|279=3|280=15|281=MUMBAI|282=0|247=10|248=1|999=248")
📝 Notes
-
Note 1: Update Retail User request can work as an independent method if only modified details tags are passed (except mandatory tags). Example: If only Bank details need to be updated, send a request with Tag-224 and mandatory tags. Sequencing of tags is not mandatory except for mandatory tags. The system updates only the tags received. This method modifies user data simultaneously for ODIN Manager and WebAdmin (similar to Create Retail User method).
-
Note 2: Avoid using special characters like |, $, =, ,, >, < unless explicitly mentioned in tags.
🏦📄 Bank Details Data
| Field Name | Req’d | Data Type (Max) | Comment |
|---|---|---|---|
| Action | O | Int (1) | Action = 1 or 2:1 – Insert/Modify2 – DeleteImportant: Applicable only for Update Retail User method. For New User Creation, this field is not expected. |
| Bank Id | M | String (20) | Bank Id of the user |
| Bank Branch Name | O | String (40) | Branch Name of the respective Bank Id |
| Bank Branch City | O | String (35) | Branch City of the respective Bank Id |
| Bank Account No | M | String (20) | Bank Account Number of the respective Bank Id |
| Bank Customer Id | O | String (10) | Customer Id of the respective Bank Id |
| Bank Account Type | M | String (3) | Account Type: CA, SB, NRE, NRO |
| Is Default Bank | O | Integer | 1 – Set as Default Bank0 – Not Default |
| PG Product | O | String (100) | Name of the PG Product to be mapped to the Bank |
📊📄 DP Details Data
| Field Name | Req’d | Data Type (Max) | Comment |
|---|---|---|---|
| Action | O | Int (1) | Action = 1 or 2:1 – Insert/Modify2 – DeleteImportant: Applicable only for Update Retail User method. For New User Creation, this field is not expected. |
| DP Id | M | String (8) | DP Id |
| Client Beneficiary Id | M | String (16) | Client Beneficiary Id |
| Holding Type | M | String (35) | Holding Type:1 – 1st Holder2 – Joint Holder 1+13 – Joint Holder 1+2 |
| Default DP | O | Char (1) | Default DP:Y – YesN – No |
| Guardian First Name | O | String (25) | Applicable if First Holder is Minor |
| Guardian Last Name | O | String (25) | Applicable if First Holder is Minor |
| Guardian DOB | O | String (10) | Format: DD-MM-YYYY (Applicable if First Holder is Minor) |
| Guardian PAN | O | String (10) | Applicable if First Holder is Minor |
| Second Holder First Name | O | String (25) | Second Holder First Name |
| Second Holder Last Name | O | String (25) | Second Holder Last Name |
| Second Holder DOB | O | String (10) | Format: DD-MM-YYYY |
| Second Holder PAN | O | String (10) | Second Holder PAN |
| Third Holder First Name | O | String (25) | Third Holder First Name |
| Third Holder Last Name | O | String (25) | Third Holder Last Name |
| Third Holder DOB | O | String (10) | Format: DD-MM-YYYY |
| Third Holder PAN | O | String (10) | Third Holder PAN |
| Remarks | O | String (25) | Remarks |
📡📨 Update Retail User Response (WCF REST Service → Client)
📘 Tags and Fields
| Tag | Field Name | Req’d | Comment |
|---|---|---|---|
| 63 | Message Version | Y | Fixed Value – FT1.0 |
| 64 | Message Type | Y | Fixed Value – 321 |
| 18 | Response Code | Y | Response Code:0 – Failure1 – Success |
| 227 | Unique Reference Number | O | Same as the one sent in the request |
| 19 | Response Message | O | Response Message |
Examples
✅ Success Case
63=FT1.0|64=321|18=1|227=UC_22012018120931|19=User update successfully
❌ Failure Cases
63=FT1.0|64=321|18=0|227=110717001213|19=Error occurred, kindly contact administrator
63=FT1.0|64=321|18=0|227=110717001213|19=Unable to connect to the remote server
⚠️ When Net.Net Service is down:
63=FT1.0|64=321|18=0|227=110717001213|19=Unable to Connect to ODIN Manager